Skip to main content

Installation and Setup

Administrator Actions​

The following installation steps require a system administrator with Windows and SQL admin rights

Install Speediful​

Run the installer and follow the on-screen prompts to install Speediful. After the installation is completed, you will be prompted to configure your SQL Server connection and register your license key(s).

info

If you receive an error during installation that "The installer failed to grant username permissions to the following directories...", you will need to grant permissions manually. Follow the steps at Installation and Setup

Enable xp_cmdshell​

Speediful requires xp_cmdshell to be enabled in order to work directly from SQL Server Management Studio. To enable xp_cmdshell in SQL Server, you need to modify some advanced configuration settings. Here's how you can do it safely:

  1. Open SQL Server Management Studio (SSMS) and connect to your SQL Server instance.

  2. Run the following T-SQL commands:

-- Allow advanced options to be changed
EXEC sp_configure 'show advanced options', 1;
RECONFIGURE;

-- Enable xp_cmdshell
EXEC sp_configure 'xp_cmdshell', 1;
RECONFIGURE;
  1. Verify it’s enabled by running:
EXEC sp_configure 'xp_cmdshell';

The run_value should be 1 if it’s enabled.

Register Your License​

A license key is required to use Speediful. During installation, you will be prompted to add your license key(s). You may add more after installation via a powershell or command prompt running with administrator permissions. For convenience, a Window start menu item is also provided to add your key(s)

Speediful will attempt to verify the license key first, and then store it

(admin powershell prompt)
PS C:\WINDOWS\system32> cd "C:\Program Files\Speediful\SLAM"
PS C:\Program Files\Speediful\SLAM> .\speediful_slam.exe register --license YOUR_LICENSE_KEY_HERE
Version: x.x.x; Build: xxxxxxxxxx [xxxxxx] (xxxxxxxxxxxxx)
Process ID: 25636
Attempting to register license: YOUR_LICENSE_K...
Checking license status
Successfully added license YOUR_LICENSE_K...
License registered successfully!

In the case of an invalid license key, you will see the following output. Double-check your license key and internet connection. If you still encounter problems, contact Speediful support.

Attempting to register license: ABC-123...
Checking license status
ERROR: The register operation failed
This license is not active. License not saved. Status: NOT_FOUND

Configure SQL Server Connection​

During installation, you will be prompted to add a server connection. After installation, you can modify this configuration. This controls the connection parameters that Speediful uses to connect to SQL Server. This is a global configuration that applies to all Speediful operations

To update the configuration, you can use an interactive mode (recommended) or command-line parameters running with administrator permissions. For convenience, a Window start menu item is also provided to update your server connection

Interactive Mode (Recommended): Each parameter will be displayed one by one. You can accept the default value in brackets by pressing enter, or provide a new value

(admin powershell prompt)
PS C:\WINDOWS\system32> cd "C:\Program Files\Speediful\SLAM"
PS C:\Program Files\Speediful\SLAM> .\speediful_slam.exe configure_server
Version: x.x.x; Build: xxxxxxxxxx [xxxxxx] (xxxxxxxxxxxxx)
Process ID: 25636


**Configure SQL Server connection settings**
Press Enter to accept defaults shown in [brackets]

SQL Server [localhost]:
ODBC Driver [{ODBC Driver 17 for SQL Server}]:
Encrypt connection (true/false) [True]:
Trust server certificate (true/false) [True]:
Connection timeout (seconds) [30]:

Database connection settings saved successfully!
  Server: localhost
  Driver: {ODBC Driver 17 for SQL Server}
  Windows Auth: True
  Encrypt: True
  Trust Certificate: True
  Timeout: 30s

Command-Line Mode: All parameters must be provided when calling the program. Note that the backtick character (`) is the powershell line continuation character

(admin powershell prompt)
PS C:\WINDOWS\system32> cd "C:\Program Files\Speediful\SLAM"
PS C:\Program Files\Speediful\SLAM> .\speediful_slam.exe configure_server `
--server "localhost" `
--driver "ODBC Driver 17 for SQL Server" `
--encrypt true `
--trust_server_certificate true `
--connection_timeout 30

Parameters:

NameTypeDefaultDescription
--server / -sSTRINGlocalhostSQL Server hostname or IP address
--driver / -dSTRINGODBC Driver 17 for SQL ServerODBC driver name
--encrypt / -eBOOLEANtrueEncrypt connection (true/false)
--trust_server_certificateBOOLEANtrueTrust server certificate (true/false)
--connection_timeoutINTEGER30Connection timeout in seconds

User Actions​

The following installation steps can be performed by a SQL developer.

Install Speediful Database Objects​

Included in the installation of Speediful are 4 SQL scripts which can be found in the \sql folder in your installation directory (by default, this is C:\Program Files\Speediful\SLAM). Run these scripts in your desired database to install Speediful's procedures, tables and out-of-the box configurations.

Always run these scripts after installing or upgrading Speediful

  • SLAM_10_procedures.sql
  • SLAM_20_activity_log.sql
  • SLAM_30_mapping_setup.sql
  • SLAM_40_compatibility_procedures.sql